API Documentation
ComplexEffect.h
1 // ComplexEffect.h
3 //
5 
6 namespace nkAstraeus
7 {
18  {
19  public :
20 
28  virtual ~ComplexEffect () ;
29 
30  // Getters
42  virtual COMPLEX_EFFECT_TYPE getType () const = 0 ;
43 
44  // Setters
53  void setName (const nkMemory::StringView& value) ;
63 
64  // Load
71  virtual bool load () = 0 ;
76  virtual void unload () = 0 ;
77  } ;
78 }
nkAstraeus::COMPLEX_EFFECT_TYPE
COMPLEX_EFFECT_TYPE
Enumerates all complex effects available in the component.
Definition: ComplexEffectType.h:12
nkAstraeus::ComplexEffect::setCompositorNode
void setCompositorNode(nkGraphics::CompositorNode *value)
nkGraphics::CompositorNode
A node in the rendering graph described by a Compositor.
Definition: CompositorNode.h:12
nkAstraeus::ComplexEffect
Base class for all complex effects in the component.
Definition: ComplexEffect.h:18
nkAstraeus::ComplexEffect::getName
nkMemory::StringView getName() const
nkAstraeus::ComplexEffect::ComplexEffect
ComplexEffect()
nkAstraeus
Encompasses all API of component NilkinsAstraeus.
Definition: Engine.h:7
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkAstraeus::ComplexEffect::getType
virtual COMPLEX_EFFECT_TYPE getType() const =0
nkAstraeus::ComplexEffect::setName
void setName(const nkMemory::StringView &value)
nkAstraeus::ComplexEffect::unload
virtual void unload()=0
nkAstraeus::ComplexEffect::~ComplexEffect
virtual ~ComplexEffect()
nkAstraeus::ComplexEffect::load
virtual bool load()=0
nkAstraeus::ComplexEffect::getCompositorNode
nkGraphics::CompositorNode * getCompositorNode() const